home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 3 / CD ACTUAL 3.iso / linux / incoming / jstools-.6v3 / jstools- / jstools-tk3.6v3.0 / lib / jdoc_util.tcl < prev    next >
Encoding:
Text File  |  1995-02-09  |  6.7 KB  |  227 lines
  1. # jdoc_util.tcl - utility procedures for jdoc
  2. # 
  3. # Copyright 1992-1994 by Jay Sekora.  All rights reserved, except 
  4. # that this file may be freely redistributed in whole or in part 
  5. # for non¡profit, noncommercial use.
  6.  
  7. ##############################################################################
  8. # jdoc:init - basic initialisation
  9. ##############################################################################
  10.  
  11. proc jdoc:init {} {
  12.   global jstools_library
  13.   global tk_library
  14.   global J_PREFS            ;# general jstools user preferences
  15.   global JDOC_PREFS            ;# user preferences for jdoc
  16.   global JDOC_PATH
  17.   
  18.   j:jstools_init            ;# prefs, libraries, bindings...
  19.   
  20.   j:rt:mkabbrevs            ;# e.g. hl for j:rt:hl
  21.   set JDOC_PATH "
  22.     .
  23.     [glob -nocomplain ~/tk/jdoc]
  24.     [glob -nocomplain ~/.tk/jdoc]
  25.     $jstools_library/jdoc
  26.     $tk_library/jdoc
  27.   "
  28. }
  29.  
  30. ##############################################################################
  31. # jdoc:load_topic - find and load a doc file,
  32. #   possibly jumping to a particular point in it
  33. #   the contents of the doc file will set up the Sections menu
  34. ##############################################################################
  35. ### USE OF MOSAIC SHOULD BE A PREFERENCE!
  36.  
  37. proc jdoc:load_topic { topic } {
  38.   global JDOC_PREFS JDOC_PATH
  39.   
  40.   .menu.sections.m delete 0 last
  41.   
  42.   set tmp_list [split $topic "#"]
  43.   set resource [lindex $tmp_list 0]
  44.   set anchor [lindex $tmp_list 1]
  45.   
  46.   # if it's a URL, view it with NCSA Mosaic
  47.   #   (THIS SHOULD BE A PREFERENCE!)
  48.   if {[string match "http:*" $resource] || \
  49.     [string match "ftp:*" $resource] || \
  50.     [string match "*.html" $resource]} {
  51.     wm withdraw .
  52.     exec Mosaic $resource
  53.     exit 0
  54.   }
  55.   
  56.   set FOUND 0
  57.   
  58.   if [string match "*.jdoc" $resource] {
  59.     set filename $resource
  60.   } else {
  61.     set filename $resource.jdoc
  62.   }
  63.   
  64.   ###
  65.   ### THE FOLLOWING NEEDS REWRITTEN FOR SIMPLICITY:
  66.   ###
  67.   if { ! [string match "/*" $filename]} {
  68.     #
  69.     # not absolute path:
  70.     #
  71.     foreach dir $JDOC_PATH {
  72.       if [file exists $dir/$filename] then {
  73.         set FOUND 1
  74.         tkwait visibility .t        ;# unpatched Tk 3.6 bug workaround
  75.         j:tag:restore_text_widget .t $dir/$filename
  76.         .t tag remove sel 1.0 end
  77.         .t mark set insert 1.0
  78.         .t yview 1.0
  79.         .t configure -state disabled
  80.   #      source $dir/$filename        ;# NEED BACKWARDS COMPATIBILITY!
  81.         if {"x$anchor" != "x"} {        ;# jump to anchor given
  82.           jdoc:go_to_anchor $anchor .t
  83.         }
  84.         break
  85.       }
  86.     }
  87.   } else {
  88.     #
  89.     # absolute path:
  90.     #
  91.     if [file exists $filename] then {
  92.       set FOUND 1
  93.       j:tag:restore_text_widget .t $filename
  94.       .t tag remove sel 1.0 end
  95.       .t mark set insert 1.0
  96.       .t yview 1.0
  97.       .t configure -state disabled
  98. #      source $dir/$filename        ;# NEED BACKWARDS COMPATIBILITY!
  99.       if {"x$anchor" != "x"} {        ;# jump to anchor given
  100.         .t yview jdoc:anchorname:${anchor}.first
  101.       }
  102.     }
  103.   }
  104.   
  105.   if {!$FOUND} then {
  106.     .t configure -state normal
  107.     j:rt text .t
  108.     j:rt:hl "Can't find a document called `$resource'."
  109.     j:rt:par
  110.     j:rt:rm "The requested document was not found.  "
  111.     j:rt:rm "It may not have been installed at your site."
  112.     j:rt:done
  113.     .t configure -state disabled
  114.     tkwait window .
  115.     exit 1
  116.   }
  117.   
  118.   .menu.sections.m add command -label "Top" -command {
  119.     .t mark set insert 1.0
  120.     .t yview insert
  121.   }
  122.   .menu.sections.m add separator
  123.   foreach pair [jdoc:find_sections .t] {
  124.     set section [lindex $pair 0]
  125.     set location [lindex $pair 1]
  126.     .menu.sections.m add command -label $section \
  127.       -command ".t mark set insert $location; .t yview insert"
  128.   }
  129.   .menu.sections.m add separator
  130.   .menu.sections.m add command -label "Bottom" -command {
  131.     .t mark set insert end
  132.     .t yview -pickplace insert
  133.   }
  134.   
  135.   wm title . "$resource"
  136.   wm iconname . "$resource"
  137. }
  138.  
  139. ######################################################################
  140. # jdoc:find_sections t - find all level 1 headings in text
  141. ######################################################################
  142.  
  143. proc jdoc:find_sections { t } {
  144.   set ranges [$t tag ranges richtext:font:heading1]
  145.   set sections {}
  146.   
  147.   ;# step through ranges two-at-a-time (start and end)
  148.   while { [llength $ranges] > 0 } {
  149.     set start [lindex $ranges 0]
  150.     set end [lindex $ranges 1]
  151.     set ranges [lreplace $ranges 0 1]    ;# with nothing, ie shift
  152.     set section_name [string trim [$t get $start $end]]
  153.     set section_name [lindex [split $section_name "\n"] 0]
  154.     lappend sections [list $section_name $start]
  155.   }
  156.   return $sections
  157. }
  158.  
  159. ######################################################################
  160. # jdoc:configure_text t - text widget configuration
  161. ######################################################################
  162.  
  163. proc jdoc:configure_text { { t .t } } {
  164.   global JDOC_PREFS
  165.   
  166.   if {$JDOC_PREFS(textwidth) < 20} {set JDOC_PREFS(textwidth) 20}
  167.   if {$JDOC_PREFS(textheight) < 4} {set JDOC_PREFS(textheight) 4}
  168.   
  169.   # fonts:
  170.   j:rt text .t                ;# let j:rt set default font
  171.   j:rt:done
  172.   
  173.   # hypertext styles and bindings:
  174.   $t tag configure jdoc:xref:link -underline 1
  175.   $t tag configure jdoc:xref:manpage -underline 1
  176.   $t tag bind jdoc:xref:link <ButtonRelease-1> \
  177.     {jdoc:x_link %W %x %y}
  178.   $t tag bind jdoc:xref:manpage <ButtonRelease-1> \
  179.     {jdoc:x_manpage %W %x %y}
  180.   $t tag configure jdoc:xref:link -underline 1
  181.   $t tag bind jdoc:xref:manpage <ButtonRelease-1> {jdoc:x_manpage %W %x %y}
  182.   
  183.   #
  184.   # OBSOLETE:
  185.   #
  186.   $t tag configure jdoc:xref:topic -underline 1 \
  187.     -background grey75 -borderwidth 1 -relief raised
  188.   $t tag configure jdoc:xref:section -underline 1 \
  189.     -background grey75 -borderwidth 1 -relief raised
  190. ###  $t tag bind jdoc:xref:topic <ButtonRelease-1> {jdoc:x_topic %W %x %y}
  191. ###  $t tag bind jdoc:xref:section <ButtonRelease-1> {jdoc:x_section %W %x %y}
  192.   
  193.   # other configuration
  194.   catch {.t configure -width $JDOC_PREFS(textwidth)}
  195.   catch {.t configure -height $JDOC_PREFS(textheight)}
  196.   catch {.t configure -background $JDOC_PREFS(textbg)}
  197.   catch {.t configure -foreground $JDOC_PREFS(textfg)}
  198.   catch {.t configure -borderwidth $JDOC_PREFS(textbw)}
  199.   catch {.t configure -selectbackground $JDOC_PREFS(textsb)}
  200.   catch {.t configure -selectforeground $JDOC_PREFS(textsf)}
  201.   catch {.t configure -selectborderwidth $JDOC_PREFS(textsbw)}
  202. }
  203.  
  204. ##############################################################################
  205. # jdoc:first_doc_file - read first doc file from command line
  206. ##############################################################################
  207.  
  208. proc jdoc:first_doc_file {} {
  209.   global argc argv
  210.   
  211.   if {$argc > 1} then {
  212.     wm withdraw .
  213.     j:alert -text \
  214.       "jdoc called with too many arguments.\nUsage: jdoc <topic>"
  215.     exit 1
  216.   }
  217.   
  218.   if {$argc != 1} then {
  219.     update
  220.     jdoc:cmd:load
  221.   } else {
  222.     set topic [lindex $argv 0]
  223.     jdoc:load_topic $topic
  224.   }
  225. }
  226.  
  227.